Retrieve monitors from group

GET 
https://ServerIP:PortNumber/api/v1/query/objects/:id/group

Call this API to obtain the monitors within a group via the corresponding Group ID.

Request

Path Parameters

id integerrequired

Unique identifier for the group. This Group ID is required to fetch the corresponding monitors.

Responses

200

Successful response. The request was processed successfully, and the status of the specified monitor is returned in the response body.

application/json

Schema

Schema

response-code integer
status string
result object[]
Array [
id integer
object.name string
]

Example (from schema)

{
  "response-code": 200,
  "status": "succeed",
  "result": [
    {
      "id": 263826484,
      "object.name": "aiops93"
    }
  ]
}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

Request Forbidden. The client does not have the necessary permissions to access this resource. This may occur if the API key or token lacks the required permissions.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

Internal Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request. This is often due to server misconfigurations or an issue with the system.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Authorization: cookie

name: cookietype: apiKeyin: cookie

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://ServerIP:PortNumber/api/v1/query/objects/:id/group' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://ServerIP:PortNumber/api/v1

Auth

Security Scheme

CookieAuthBearerAuth

CookieAuth

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!